<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>oak-show-limits: openark kit documentation</title>
	<meta name="description" content="oak-show-limits: openark kit" />
	<meta name="keywords" content="oak-show-limits: openark kit" />
	<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>openark kit documentation</h1>
			<div class="subtitle">Common utilities for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="oak-show-limits.html">oak-show-limits</a></h2>	
<h3>NAME</h3>
oak-show-limits: show AUTO_INCREMENT "free space"
<h3>SYNOPSIS</h3>
Show all AUTO_INCREMENT columns, current AUTO_INCREMENT values and upper bounds, usage ratio, on all schemata and on all tables:
<blockquote>oak-show-limits</blockquote>
As above, for tables in the `world` database only:
<blockquote>oak-show-limits --database=world</blockquote>
As above, on the given table only:
<blockquote>oak-show-limits --database=world --table=City</blockquote>
Only diagnose columns named `id`, on all schemata and all tables:
<blockquote>oak-show-limits --column=id</blockquote>
Only report columns where the current AUTO_INCREMENT value exceeds 10% of upper bound.
<blockquote>oak-show-limits --threshold=0.1</blockquote>
Same as above, provide connection parameters, prompt for password:
<blockquote>oak-show-limits --user=root --ask-pass --socket=/tmp/mysql.sock -l 0.1</blockquote>
Same as above, use defaults file:
<blockquote>oak-show-limits --defaults-file=/home/myuser/.my-oak.cnf -l 0.1</blockquote>
<h3>DESCRIPTION</h3>
oak-show-limits looks for AUTO_INCREMENT columns, and compares current values with the column type. It reports those columns where the AUTO_INCREMENT value is higher than a given threshold.

This utility can be used for diagnosing underestimated and overestimated  data type ranges. Underestimated data types are those in which the AUTO_INCRMENET current value is approaching the upper limit. Overestimated data types are those where the current value is extremely far from the upper limit.

Output is in tab delimited, where each row specifies:
<ul>
	<li>An AUTO_INCREMENT fully qualified column name</li>
	<li>Current AUTO_INCREMENT value and upper bound</li>
	<li>Usage ratio (max value/upper bound)</li>
</ul>
<h3>OPTIONS</h3>
--ask-pass
<p class="indent">Prompt for password.</p>

-c COLUMN_NAME, --column=COLUMN_NAME
<p class="indent">AUTO_INCREMENT column name (leave blank for all AUTO_INCREMENT columns)</p>

-d DATABASE_NAME, --database=DATABASE_NAME
<p class="indent">Database name (if not specified, all schemata are analyzed)</p>

--defaults-file=DEFAULTS_FILE
<p class="indent">Read from MySQL configuration file. Overrides --user, --password, --socket, --port.</p>
<p class="indent">Configuration needs to be in the following format:</p>

<p class="indent"><strong>[client]<br/>
user=my_user<br/>
password=my_pass<br/>
socket=/tmp/mysql.sock<br/>
port=3306</strong>
</p>

-H HOST, --host=HOST
<p class="indent">MySQL host (default: localhost)</p>

-l RATIO_THRESHOLD, --threshold=RATIO_THRESHOLD
<p class="indent">Only show ratios larger than given threshold in range [0..1)</p>

-p PASSWORD, --password=PASSWORD
<p class="indent">MySQL password</p>

-P PORT, --port=PORT
<p class="indent">TCP/IP port (default: 3306)</p>

-S SOCKET, --socket=SOCKET
<p class="indent">MySQL socket file. Only applies when host is localhost</p>

-t TABLE_NAME, --table=TABLE_NAME
<p class="indent">Table name (if not specified, all tables are analyzed)</p>

-u USER, --user=USER
<p class="indent">MySQL user</p>

<h3>ENVIRONMENT</h3>
Requires MySQL 5.0 or newer, python 2.3 or newer.

python-mysqldb must be installed in order to use this tool. You can
<blockquote>apt-get install python-mysqldb</blockquote>
or
<blockquote>yum install mysql-python</blockquote>
<h3>SEE ALSO</h3>
<h3>LICENSE</h3>
This tool is released under the BSD license.
<blockquote><pre>Copyright (c) 2008 - 2010, Shlomi Noach
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</pre>
</blockquote>
<h3>AUTHOR</h3>
Shlomi Noach
				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="menu">
					<h3>openark kit tools</h3>
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="oak-apply-ri" href="oak-apply-ri.html">oak-apply-ri</a></li>
						<li><a title="oak-block-account" href="oak-block-account.html">oak-block-account</a></li>
						<li><a title="oak-chunk-update" href="oak-chunk-update.html">oak-chunk-update</a></li>
						<li><a title="oak-get-slave-lag" href="oak-get-slave-lag.html">oak-get-slave-lag</a></li>
						<li><a title="oak-hook-general-log" href="oak-hook-general-log.html">oak-hook-general-log</a></li>
						<li><a title="oak-kill-slow-queries" href="oak-kill-slow-queries.html">oak-kill-slow-queries</a></li>
						<li><a title="oak-modify-charset" href="oak-modify-charset.html">oak-modify-charset</a></li>
						<li><a title="oak-online-alter-table" href="oak-online-alter-table.html">oak-online-alter-table</a></li>
						<li><a title="oak-prepare-shutdown" href="oak-prepare-shutdown.html">oak-prepare-shutdown</a></li>
						<li><a title="oak-purge-master-logs" href="oak-purge-master-logs.html">oak-purge-master-logs</a></li>
						<li><a title="oak-repeat-query" href="oak-repeat-query.html">oak-repeat-query</a></li>
						<li><a title="oak-security-audit" href="oak-security-audit.html">oak-security-audit</a></li>
						<li><a title="oak-show-limits" href="oak-show-limits.html">oak-show-limits</a></li>
						<li><a title="oak-show-replication-status" href="oak-show-replication-status.html">oak-show-replication-status</a></li>
					</ul>
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">openark kit</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
